PsL Monthly 1993 December

home *** CD-ROM | disk | FTP | other *** search

/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / pascal / ts_str.com / TS_STR.DOC < prev next >

Wrap

Text File | 1989-12-25 | 19.7 KB | 442 lines

----------------------------------------------------------------------- T U R B O S T U F F v 0 2 . 0 1 . 0 0 ----------------------------------------------------------------------- \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ \\///////////////////////////////////////////////////////////////////\\ \\///////////////// // // // // // ////////////\\ \\////////////////// //// // // // // // // // /////////////\\ \\///////////////// //// // // // /// // //////////////\\ \\//////////////// //// // // / /// // // // ///////////////\\ \\/////////////// //// // // // // ////////////////\\ \\///////////////////////////////////////////////////////////////////\\ \\///////////////////////////////////////////////////////////////////\\ \\///////////////// // // // // // ////////////\\ \\//////////////// //////// //// // // ////// /////////////////\\ \\/////////////// //// //// // // /// ///////////////\\ \\////////////////// //// //// // // ////// ///////////////////\\ \\///////////// //// //// // ////// ////////////////////\\ \\///////////////////////////////////////////////////////////////////\\ \\///////////////////////////////////////////////////////////////////\\ \\//////////// // ////////// // // /////////\\ \\///////////// //// ////////////// //////// //// // //////////\\ \\//////////// //// ////////// //// //// ///////////\\ \\/////////// //////// ////////////// //// //// / /////////////\\ \\////////// //// // // //// //// // /////////////\\ \\///////////////////////////////////////////////////////////////////\\ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ TS_STR Module Documentation Shenandoah Valley Software P.O. Box 1456 Winchester, Va 22601 703-665-6491 ----------------------------------------------------------------------- (C) Copyright 1989 by Shenandoah Valley Software -- All Rights Reserved ----------------------------------------------------------------------- TS_Str TURBO STUFF DOCUMENTATION Page: 1 _______________________________________________________________________ T A B L E O F C O N T E N T S TS_STR Documentation Introduction ................................................... 2 Included Files ................................................. 2 Support ........................................................ 2 Registration Information ....................................... 3 System Requirements ............................................ 3 License Agreement .............................................. 4 License Statement............................................... 4 Restricted Permission to Copy .................................. 4 Limited Warranty ............................................... 4 Governing Law .................................................. 5 Site License ................................................... 5 Special Distribution License ................................... 5 Customization of Software ...................................... 5 Source Code Availability ....................................... 5 Using Turbo Stuff .............................................. 6 Using Individual Routines ...................................... 6 Recompiling the Turbo Stuff Unit ............................... 7 Routine Summary ................................................ 7 TS_Str TURBO STUFF DOCUMENTATION Page: 2 _______________________________________________________________________ INTRODUCTION Turbo Stuff is a set of routines being developed in assembler for use with Turbo Pascal. Assembler is being used for optimum speed and coding size. Several modules are being developed with this being the first major release. This module, TS_STR, contains forty string related routines. Other modules being planned include an extensive Time/Date module, fast video routines, system configuration, extended keyboard and mouse i/o, and several others. Once all planned modules have been completed they will be combined into one large package to be made available as Shareware. It should be noted at this time that registration of any one module automatically gets you all the other modules as they are released. The only additional future charge will be for the printed documentation should registered user wish to purchase it. The completed Turbo Stuff package will come in two flavors. The first is the shareware version, while 100% functional, it will not include source code. Only the source for the TPU will be included as will all routines in OBJ format. The second flavor will be commercial and is the version that all registered users will receive. It will contain all source code as well as a few "extra" modules not available in the shareware version. Registration at this time is $40.00 and for a more detailed description of benefits, please refer to that section below. INCLUDED FILES This archive, either ZIP or ARC format, should contain the following files. If any of the below files are missing, the entire non-registered module is available for $5.00. (see the TS_STR.REG file). TS_DEM.PAS - Demonstration program for this module TS_OBJ.ARC - Archive containing the OBJ files for the various routines. (Note: this may be a ZIP file) TS_STR.BUG - Bug reporter TS_STR.DOC - This documentation file TS_STR.PAS - Source code for the TPU file TS_STR.REG - Registration mailer TS_STR.REF - Routine reference documentation TS_STR.TPU - Turbo Pascal v5.5 Unit SUPPORT For questions, comments (both good and bad are desired), or suggestions use any of the below listed methods: 1. Via CompuServe [71337,1116] 2. Via GEnie [J.COULTER] 3. Via US Mail - SVS, P.O.Box 1456, Winchester, VA, 22601 4. If you really need to reach me (Jonathan Coulter) via phone, you can do so after 6:00pm eastern time at 703-665-6491. (no collect calls please) TS_Str TURBO STUFF DOCUMENTATION Page: 2 _______________________________________________________________________ REGISTRATION INFORMATION Registration of Turbo Stuff is $40 at this time. Once the final package has been completed, this price may (not likely) go up. Registration will grant you the following benefits: 1. You will receive all completed modules to date. 2. You will receive all new modules automatically, and free of charge, as they are completed. 3. You will receive the final Turbo Stuff package once completed. The target date is Spring 1990. 4. You will get notification of new products released and in most cases special discounts toward registration or purchase. 5. You will help support the continued development and improvement of both the Turbo Stuff package and future Shareware products. Without such support inexpesive, professional quality software would not be available. ** To register, see the TS_STR.REG mailer file ** SYSTEM REQUIREMENTS Turbo Stuff requires Turbo Pascal v4.0, 5.0 or 5.5. Hardware required is an IBM PC/XT/AT or 100% compatible. The TS_STR module will work with any video adapter. All routines work equally well with any printer make or brand. TS_Str TURBO STUFF DOCUMENTATION Page: 4 _______________________________________________________________________ LICENSE AGREEMENT CAREFULLY READ THE FOLLOWING TERMS AND CONDITIONS. IF YOU DO NOT AGREE WITH THEM, YOU SHOULD PROMPTLY RETURN THE PACKAGE FOR A REFUND IF PURCHASED, OR AQUIRED BY OTHER MEANS YOU SHOULD NOT MAKE USE OF IT. USE OF PROGRAMS DEVELOPED BY SHENANDOAH VALLEY SOFTWARE INDICATES YOUR ACCEPTANCE OF THIS AGREEMENT. LICENSE STATEMENT This software is protected by United States copyright law and inter- national treaty provisions. RESTRICTED PERMISSION TO COPY The conditions under which you may copy ShareWare programs developed by SVS and their documentation are clearly outline below. Individuals are granted permission by SVS to freely copy the program for their own use or for others to EVALUATE, as long as no price or other compensation is charged. Printed manuals may not be copied without the express written permission of SVS. The program may only be copied and distributed under the following conditions: 1. No price or other compenstation may be charged. However, a distribu- tion cost may be charged for the cost of the diskette, shipping and handling, as long as this cost does not exceed $10 total. 2. The program or disk-documentation may not be modified in any way and must always be distributed together. 3. The program may not be sold as part of some other inclusive package. 4. The program may not be "rented" to others. 5. The printed User Manual may not be copied or reproduced in any way. LIMITED WARRANTY WITH RESPECT TO THE PHYSICAL DISKETTE AND DOCUMENTATION AQUIRED THROUGH REGISTRATION, SVS WARRANTS THE SAME TO BE FREE OF DEFECTS IN MATERIALS AND/OR WORKMANSHIP FOR A PERIOD OF 90 DAYS FROM THE DATE OF PURCHASE. IN THE EVENT OF NOTIFICATION WITHIN THE WARRANTY PERIOD OF DEFECTS IN MATERIALS AND/OR WORKMANSHIP, SVS WILL REPLACE THE DEFECTIVE DOCUMENT- ATION OR DISKETTE. THE REMEDY FOR BREACH OF THIS WARRANTY SHALL BE LIMITED TO REPLACEMENT AND SHALL NOT ENCOMPASS ANY OTHER DAMAGES, INCLUDING BUT NOT LIMITED TO LOSS OF PROFIT, AND SPECIAL, INCIDENTAL, CONSEQUENTIAL OR OTHER SIMILAR CLAIMS. SVS ESPECIALLY DISCLAIMS ALL OTHER WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SVS BE LIABLE FOR ANY LOSS OF PROFIT OR ANY OTHER DAMAGE, INCLUDING BUT NOT LIMITED TO SPECIAL, INCIDENTAL, CONSEQUENTIAL OR OTHER DAMAGES IN EXCESS OF THE REGISTRATION FEE UNDER THIS LICENSE AGREEMENT. TS_Str TURBO STUFF DOCUMENTATION Page: 5 _______________________________________________________________________ GOVERNING LAW This agreement shall be construed, interpreted and governed by the laws of the state of Virginia. SITE LICENSE This is a license for use of the software within your company, and is non-transferable. This allows internal use and copying of the software by as many users/machines as contracted for. An unlimited Site License is available which allows unlimited copying of the software or internal use by your company. Distribution, repackaging, or reselling of the software to third parties is forbidden. For more information on the availability and pricing of a Site License write to Shenandoah Valley Software. SPECIAL DISTRIBUTION LICENSE This license allows distribution of the software with commercial software that is manufactured by your company. This license is non- exclusive and non-transferable. For more information and a quote on the one time Distribution License fee, write to Shenandoah Valley Software detailing your software, market, pricing, etc, and the reason for wanting to include our software with your product. You will receive a prompt reply. CUSTOMIZATION OF SOFTWARE Shenandoah Valley Software will customize its software for your usage. Such modification will be done for registered users only with the additional cost as quoted. For more information, detail the modifi- cation(s) you require and mail to Shenandoah Valley Software. You will receive a prompt reply and quotation. SOURCE CODE AVAILABILITY With the sole exception of software packages designed to aid in prog- ramming, Shenandoah Valley Software will not release source code for its products. For those utilities which aid in programming, only users who register will receive source code. TS_Str TURBO STUFF DOCUMENTATION Page: 6 _______________________________________________________________________ USING TURBO STUFF If you are using Turbo Pascal v5.5 you need to follow these two steps. If you are not using version 5.5 see the section below regarding recompiling Turbo Stuff. 1. Place TS_STR in your program's USES line 2. Add at the top of your program the {$V-} compiler directive For example: PROGRAM MyProgram; {$V-} USES Crt,Dos,TS_Str; BEGIN END. USING INDIVIDUAL ROUTINES One problem in using assembler routines in Turbo Pascal is that all procedures and/or functions contained in a single OBJ file are compiled into your program whether you use all of the procedures or not. To get around this SVS has compiled each routine seperately. This means that only those routines your program uses will be linked. Another advantage to this seperate OBJ file method is that even though Turbo only links those routines used, it still includes all the info- rmation contained in the INTERFACE section of the unit. Although the amount of space used is small, there is none the less extra space used. Included in the archive file TS_OBJ.ARC (or .ZIP) is the .OBJ file for each routine in the module. You can link this into your program direct- ly without using the unit. Below is an example using the DUP function. {$F+} FUNCTION Dup ( Ch:char; Len:byte ) : string; external; {$L UPPER} {$F-} The {$F+} ... {$F-} is required to turn FAR procedure on and off. The next line defines just the header of the routine. You can find this in the TS_STR.REF file. For functions, use the following information found in that file. The two items within quotes are the name of the fields in the REF file that hold the information, just copy it exactly. FUNCTION "Declaration" : "Result Type"; external; For procedures (procedures have no "Result Type"), use the following: PROCEDURE "Declaration"; external; Next is the {$L} directive. This specifies the name of the .OBJ file to link with the program. The name of the file can be found in the REF file as well under the field "Source File". TS_Str TURBO STUFF DOCUMENTATION Page: 7 _______________________________________________________________________ RECOMPILING THE TURBO STUFF UNIT Is you do not have version 5.5 of Turbo Pascal, you will need to re- compile the unit under your version. To do so you will need to unarc (or unzip) the TS_OBJ file in the same directory as the TS_STR.PAS file. You can then recompile the unit with Turbo's TPC utility thusly: TPC TS_STR If you don't have the TPC utility handy, you can do the same by just loading the TS_STR.PAS file with the Turbo Editor and compile to disk. ROUTINE SUMMARY Ascii - converts an Asciiz string back to Turbo standard format Asciiz - converts a Turbo standard string to a null terminated one ATrim - trims leading/trailing characters from a string Center - centers a string within a field Change - changes every occurance of a character with another Compare - compares two strings with case option DelCh - deletes every occurance of a character within a string Decrypt - decrypts a string formerly encryted with Encrypt Dup - duplicates a character a specific number of times DupStr - duplicates a string a up to a specific length Encrypt - encrypts a string to make it unreadable FirstLower - returns the first lowercase character in a string FirstUpper - returns the first uppercase character in a string Format - formats a string using a specific mask IIF - immediate If function for a short-cut IF..THEN..ELSE IsAplha - checks a string/char for only ABCs IsLower - checks a string/char for only lowercase ABCs IsUpper - checks a string/char for only uppercase ABCs LFill - pads the left of a string with a specific character Left - returns only the leftmost portion of a string LJust - left justifies a string in a field of spaces LoCase - returns a lowercase character Lower - converts a string to all lowercase characters LTrim - trims leading characters from a string Number - formats a number with commas and decimals Proper - converts the first letter of a word to upper, rest lower RFill - pads the right of a string with a specific character Right - returns only the rightmost portion of a string RJust - right justifies a string in a field of spaces Roman - returns a roman numerial for the integer passed RTrim - trims trailing characters from a string Same - compares two strings with wildcards SoundDif - returns a difference code between two soundex codes SoundEx - returns a four digit "sound" code for a string Space - returns a string of spaces of a specific length Stuff - "stuffs" a string into another with optional deletion Swap - swaps the contents of two strings Trim - trims leading/trailing spaces from a string Upper - converts a string to all uppercase characters Words - returns the number of words in a string ** FOR MORE EXACT INFORMATION SEE THE TS_STR.REF FILE **